---
title: Employment Hero
sidebarTitle: Employment Hero
---

import Overview from "/snippets/overview.mdx"
import PreBuiltTooling from "/snippets/generated/employment-hero/PreBuiltTooling.mdx"
import PreBuiltUseCases from "/snippets/generated/employment-hero/PreBuiltUseCases.mdx"

<Overview />
<PreBuiltTooling />
<PreBuiltUseCases />

## Access requirements
| Pre-Requisites | Status | Comment|
| - | - | - |
| Paid dev account | ✅ Not required | Free, self-signup for an [Employment Hero account](https://employmenthero.com/free-trial/). |
| Paid test account | ✅ Not required | Free, self-signup for an [Employment Hero account](https://employmenthero.com/free-trial/). |
| Partnership | ✅ Not required | |
| App review | ✅ Not required | |
| Security audit | ✅ Not required | |


## Setup guide

<Steps>
  <Step title="Create an Employment Hero account">
    Go to [Employment Hero signup page](https://employmenthero.com/free-trial/) and create a free account. Once your account is created, you can access the Developer Dashboard.
  </Step>
  <Step title="Access the Developer Portal">
    1. Log in to your [Employment Hero](https://secure.employmenthero.com/users/sign_in) account.  
    2. Click on your profile from the top right corner then click **Developer Portal**.  
  </Step>
  <Step title="Create a new app">
    1. In the Developer Portal, navigate to the **API** page and click the **Add Application** button.
    2. Enter a **Name** for your app and set `https://api.nango.dev/oauth/callback` as the **Redirect URI**.
    3. Select the required API scopes.  
    4. Click **Create** to finalize your application.  
    5. Once your application is created, a **Client ID** and **Client Secret** will be displayed. Copy these credentials, as you will need them when setting up the integration in Nango.
  </Step>
  <Step title="Next">
    Follow the [_Quickstart_](/getting-started/quickstart).  
  </Step>
</Steps>

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>


## Useful links

| Topic | Links | 
| - | - | 
| General | [Website](https://employmenthero.com/) |
| | [Create an account](https://employmenthero.com/free-trial/) |
| | [Sign in to your account](https://secure.employmenthero.com/users/sign_in) |
| Developer | [API documentation](https://developer.employmenthero.com) |
| | [Authentication documentation](https://developer.employmenthero.com/api-references/#icon-key-authentication) |
| | [OAuth 2.0 guide](https://developer.employmenthero.com/api-references/#obtain-access-token) |
| | [How to register an application](https://developer.employmenthero.com/api-references/#obtain-credentials) |

<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/employment-hero.mdx)</Note>


## Common Scopes

| Scope | Description |
| ----- | ----------- |
| organisations:list | Read all organisations you belong to |
| organisations:show | Read organisations details |
| employees:list | Read all employees which belong to an organisation |
| teams:list | Read all teams which belong to an organisation |
| invoices:list| Read all invoices which belong to an organisation |
| payslips:list | Read all payslips which belong to an employee  |

## API gotchas

- The scopes used are the ones selected when creating a new application on the developer portal, so there is no need to supply scopes within Nango.

<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/employment-hero.mdx)</Note>
